Resource URL: /platform/<<version=3>>/antivirus/policies/<NAME>

    Overview: This resource represents the antivirus scan policies configured
              on a cluster.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve one antivirus scan policy.

       URL: GET /platform/<<version=3>>/antivirus/policies/<NAME>

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "policies": {
          "minItems": 0, 
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An antivirus scan policy.", 
            "properties": {
              "impact": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "The priority of the antivirus scan job.  Must be a valid job engine impact policy, or null to use the default impact."
              }, 
              "paths": {
                "minItems": 0, 
                "items": {
                  "minLength": 0, 
                  "type": "string", 
                  "pattern": "^/ifs.*", 
                  "maxLength": 4096
                }, 
                "type": "array", 
                "description": "Paths to include in the scan.", 
                "maxItems": 4294967295
              }, 
              "description": {
                "minLength": 0, 
                "type": "string", 
                "description": "A description for the policy.", 
                "maxLength": 255
              }, 
              "schedule": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "The schedule for running scans in isi date format.  Examples include: 'every Friday' or 'every day at 4:00'.  A null value means the policy is manually scheduled."
              }, 
              "recursion_depth": {
                "minimum": -1, 
                "type": "integer", 
                "description": "The depth to recurse in directories.  The default of -1 gives unlimited recursion.", 
                "maximum": 2147483647
              }, 
              "enabled": {
                "type": "boolean", 
                "description": "Whether the policy is enabled."
              }, 
              "last_run": {
                "minimum": 0, 
                "type": "integer", 
                "description": "The epoch time of the last run of this policy.", 
                "maximum": 4294967295
              }, 
              "force_run": {
                "type": "boolean", 
                "description": "Forces the scan to run regardless of whether the files were recently scanned."
              }, 
              "id": {
                "minLength": 0, 
                "type": "string", 
                "description": "A unique identifier for the policy.", 
                "maxLength": 255
              }, 
              "name": {
                "minLength": 0, 
                "type": "string", 
                "description": "The name of the policy.", 
                "maxLength": 255
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify an antivirus scan policy.

       URL: PUT /platform/<<version=3>>/antivirus/policies/<NAME>

There are no query arguments for this method.

PUT request body schema:
{
  "additionalProperties": false, 
  "type": "object", 
  "description": "An antivirus scan policy.", 
  "properties": {
    "impact": {
      "type": [
        {
          "minLength": 0, 
          "type": "string", 
          "maxLength": 255
        }, 
        {
          "type": "null"
        }
      ], 
      "description": "The priority of the antivirus scan job.  Must be a valid job engine impact policy, or null to use the default impact."
    }, 
    "paths": {
      "minItems": 0, 
      "items": {
        "minLength": 0, 
        "type": "string", 
        "pattern": "^/ifs.*", 
        "maxLength": 4096
      }, 
      "type": "array", 
      "description": "Paths to include in the scan.", 
      "maxItems": 4294967295
    }, 
    "description": {
      "minLength": 0, 
      "type": "string", 
      "description": "A description for the policy.", 
      "maxLength": 255
    }, 
    "schedule": {
      "type": [
        {
          "minLength": 0, 
          "type": "string", 
          "maxLength": 255
        }, 
        {
          "type": "null"
        }
      ], 
      "description": "The schedule for running scans in isi date format.  Examples include: 'every Friday' or 'every day at 4:00'.  A null value means the policy is manually scheduled."
    }, 
    "recursion_depth": {
      "minimum": -1, 
      "type": "integer", 
      "description": "The depth to recurse in directories.  The default of -1 gives unlimited recursion.", 
      "maximum": 2147483647
    }, 
    "enabled": {
      "type": "boolean", 
      "description": "Whether the policy is enabled."
    }, 
    "force_run": {
      "type": "boolean", 
      "description": "Forces the scan to run regardless of whether the files were recently scanned."
    }, 
    "name": {
      "minLength": 0, 
      "type": "string", 
      "description": "The name of the policy.", 
      "maxLength": 255
    }
  }
}

There is no JSON response body for this method.

********************************************************************************

Method DELETE: Delete an antivirus scan policy.

          URL: DELETE /platform/<<version=3>>/antivirus/policies/<NAME>

There are no query arguments for this method.

There is no JSON response body for this method.
